Add Grandstream Home integration by wtxu-gs · Pull Request #167872 · home-assistant/core

wtxu-gs · 2026-04-10T07:40:30Z

This integration adds support for Grandstream GDS/GNS/GSC devices.

Features:

System status sensors
Zeroconf discovery

Breaking change

Proposed change

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add Grandstream Home integration documentation
Link to brands pull request: Add grandstream brand assets

Checklist

I understand the code I am submitting and can explain how it works.
The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.
Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

mawoka-myblock · 2026-04-10T08:09:02Z

The source for the library is missing: https://github.com/GrandstreamEngineering/grandstream_home_api

wtxu-gs · 2026-04-10T08:42:26Z

The source for the library is missing: https://github.com/GrandstreamEngineering/grandstream_home_api

It is added now

wtxu-gs · 2026-04-10T09:12:45Z

docs PR: home-assistant/home-assistant.io#44623

edenhaus

I did an initial review until I stopped as this PR is to huge. Some code needs to move to the library and also the config flow is huge. Please refactor the code and make it more readable.

Also the library needs a working workflow to deploy directly to pypi.
As 10.000 changes is to much, can we just add a single device/model in this PR and then add other models in a follow up PR. This PR needs to be a lot smaller

homeassistant/components/grandstream_home/quality_scale.yaml

homeassistant/components/grandstream_home/__init__.py

homeassistant/components/grandstream_home/device.py

homeassistant/components/grandstream_home/error.py

homeassistant/components/grandstream_home/manifest.json

homeassistant/components/grandstream_home/sensor.py

home-assistant · 2026-04-10T12:15:38Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

joostlek · 2026-04-14T13:36:48Z

homeassistant/components/grandstream_home/config_flow.py

+    # Reauthentication Flow
+    async def async_step_reauth(


Please keep reauth out of the first PR

joostlek · 2026-04-14T13:37:11Z

homeassistant/components/grandstream_home/config_flow.py

+        # Store auth info
+        self._auth_info = {
+            CONF_USERNAME: username,
+            CONF_PASSWORD: encrypt_password(password, self.unique_id or "default"),


Why do we encrypt the password?

joostlek · 2026-04-14T13:37:26Z

homeassistant/components/grandstream_home/__init__.py

+    # Initialize global API lock if not exists
+    hass.data.setdefault(DOMAIN, {})
+    if "api_lock" not in hass.data[DOMAIN]:
+        hass.data[DOMAIN]["api_lock"] = asyncio.Lock()


Why do we need a global API lock?

joostlek · 2026-04-14T13:38:01Z

homeassistant/components/grandstream_home/__init__.py

+        if error_type == "offline":
+            _LOGGER.warning("API login failed (device may be offline)")
+            return


Why does the device need to login to the API?

joostlek · 2026-04-14T13:38:09Z

homeassistant/components/grandstream_home/__init__.py

+        if error_type == "ha_control_disabled":
+            raise ConfigEntryAuthFailed(
+                "Home Assistant control is disabled on the device. "
+                "Please enable it in the device web interface."
+            )


Why can HA control be disabled?

joostlek · 2026-04-14T13:46:35Z

homeassistant/components/grandstream_home/coordinator.py

+    async def async_handle_push_data(self, data: dict[str, Any]) -> None:
+        """Handle pushed data."""
+        try:
+            _LOGGER.debug("Received push data: %s", data)
+            data = process_push_data(data)
+            self.last_update_method = "push"
+            self.async_set_updated_data(data)
+        except Exception as e:
+            _LOGGER.error("Error processing push data: %s", e)
+            raise
+
+    def handle_push_data(self, data: dict[str, Any]) -> None:
+        """Handle push data synchronously."""
+        try:
+            _LOGGER.debug("Processing sync push data: %s", data)
+            data = process_push_data(data)
+            self.last_update_method = "push"
+            self.async_set_updated_data(data)
+        except Exception as e:
+            _LOGGER.error("Error processing sync push data: %s", e)
+            raise


Where does this happen

joostlek · 2026-04-14T13:46:53Z

homeassistant/components/grandstream_home/device.py

I am not sure what the task of this class is, should this be a base entity instead?

joostlek · 2026-04-14T13:47:05Z

homeassistant/components/grandstream_home/manifest.json

+      "type": "_https._tcp.local."
+    },
+    {
+      "name": "*",


I think matching on asterisk is too broad

joostlek · 2026-04-14T13:47:46Z

homeassistant/components/grandstream_home/sensor.py

+        # Add SIP account sensors (only if accounts exist)
+        # Track by account ID instead of index
+        sip_accounts = coordinator.data.get("sip_accounts", [])
+        for account in sip_accounts:
+            if isinstance(account, dict):
+                account_id = account.get("id", "")
+                if account_id:
+                    entities.extend(
+                        GrandstreamSipAccountSensor(
+                            coordinator, device, description, account_id
+                        )
+                        for description in SIP_ACCOUNT_SENSORS
+                    )
+                    created_sip_sensors.add(account_id)
+
+        # Add listener to dynamically add new SIP account sensors
+        @callback
+        def _async_add_sip_sensors() -> None:
+            """Add new SIP account sensors when accounts are added."""
+            sip_accounts = coordinator.data.get("sip_accounts", [])
+            new_entities: list[GrandstreamSipAccountSensor] = []
+
+            for account in sip_accounts:
+                if isinstance(account, dict):
+                    account_id = account.get("id", "")
+                    if account_id and account_id not in created_sip_sensors:
+                        new_entities.extend(
+                            GrandstreamSipAccountSensor(
+                                coordinator, device, description, account_id
+                            )
+                            for description in SIP_ACCOUNT_SENSORS
+                        )
+                        created_sip_sensors.add(account_id)
+
+            if new_entities:
+                async_add_entities(new_entities)
+
+        # Register listener
+        config_entry.async_on_unload(
+            coordinator.async_add_listener(_async_add_sip_sensors)
+        )
+


Can we keep dynamic devices out of this PR

joostlek · 2026-04-14T13:48:38Z

homeassistant/components/grandstream_home/sensor.py

Can we cut this down to a single type of information first and add the rest in later PRs? I think that will make this much more reviewable

Copilot AI review requested due to automatic review settings April 10, 2026 07:40

home-assistant bot added cla-signed has-tests integration: grandstream_home new-integration quality-scale labels Apr 10, 2026

Copilot started reviewing on behalf of wtxu-gs April 10, 2026 07:41 View session

wtxu-gs force-pushed the feat/grandstream_home branch 2 times, most recently from d30e08d to fef1454 Compare April 10, 2026 07:53

c0ffeeca7 mentioned this pull request Apr 10, 2026

Add Grandstream Home integration documentation home-assistant/home-assistant.io#44617

Closed

7 tasks

wtxu-gs force-pushed the feat/grandstream_home branch 2 times, most recently from 8aad180 to 39a400b Compare April 10, 2026 08:04

wtxu-gs force-pushed the feat/grandstream_home branch 4 times, most recently from f443b7c to aa77908 Compare April 10, 2026 08:37

wtxu-gs force-pushed the feat/grandstream_home branch from aa77908 to 8a3b791 Compare April 10, 2026 08:43

wtxu-gs force-pushed the feat/grandstream_home branch from 8a3b791 to 0b3e604 Compare April 10, 2026 10:19

c0ffeeca7 mentioned this pull request Apr 10, 2026

Add Grandstream Home integration documentation home-assistant/home-assistant.io#44623

Open

8 tasks

edenhaus requested changes Apr 10, 2026

View reviewed changes

home-assistant bot marked this pull request as draft April 10, 2026 12:15

wtxu-gs force-pushed the feat/grandstream_home branch 2 times, most recently from 94772a0 to 62a2b83 Compare April 13, 2026 10:45

wtxu-gs marked this pull request as ready for review April 13, 2026 10:45

home-assistant bot requested a review from edenhaus April 13, 2026 10:45

wtxu-gs force-pushed the feat/grandstream_home branch from 62a2b83 to 3adbbd7 Compare April 13, 2026 10:58

wtxu-gs added 2 commits April 13, 2026 18:58

Add Grandstream Home integration

cb6d300

Fix review optimization suggestions

a5c791e

wtxu-gs force-pushed the feat/grandstream_home branch from 3adbbd7 to a5c791e Compare April 13, 2026 10:58

wtxu-gs requested a review from joostlek April 13, 2026 11:00

joostlek requested changes Apr 14, 2026

View reviewed changes

home-assistant bot marked this pull request as draft April 14, 2026 13:49

Uh oh!

Conversation

wtxu-gs commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Type of change

Additional information

Checklist

Uh oh!

mawoka-myblock commented Apr 10, 2026

Uh oh!

wtxu-gs commented Apr 10, 2026

Uh oh!

wtxu-gs commented Apr 10, 2026

Uh oh!

edenhaus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

home-assistant bot commented Apr 10, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

wtxu-gs commented Apr 10, 2026 •

edited

Loading